home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / graphic / chiaro10.zip / GIFSTRIP.DOC < prev    next >
Text File  |  1993-03-12  |  30KB  |  740 lines
  1. GIFSTRIP 2.2 DOCUMENTATION
  2. ==========================
  3. James W. Birdsall
  4. 03/19/93
  5.  
  6.  
  7. 0. CONTENTS
  8. -----------
  9.    0.      CONTENTS
  10.    1.      INTRODUCTION
  11.     1.1     Quick Reference
  12.     1.2     Copyright, License, and Warranty Disclaimer
  13.    2.      USAGE
  14.     2.1     Targets
  15.      2.1.1   Wildcards
  16.     2.2     Options
  17.      2.2.1   Output redirection options
  18.      2.2.2   Rebuilding and processing options
  19.      2.2.3   Temporary Storage Options
  20.      2.2.4   -# Version
  21.      2.2.5   -? Help
  22.    3.      OUTPUT
  23.     3.1     File Header Line
  24.     3.2     Internal Section Lines
  25.      3.2.1   Image
  26.      3.2.2   Extension Block
  27.      3.2.3   Other Lines
  28.     3.3     Terminator Line
  29.     3.4     No Rebuild
  30.     3.5     Rebuild
  31.     3.6     Examples
  32.    4.      THE END
  33.  
  34.  
  35. 1. INTRODUCTION
  36. ---------------
  37.  
  38.    GIFSTRIP is a program of the Chiaro suite. It removes excess
  39. characters, if present, from GIF-format image files. Excess characters
  40. may be added in a variety of ways, including XMODEM-protocol file
  41. transfers or transfer from a Macintosh computer. I have observed files
  42. with anywhere from one byte to 13K of excess characters; in the latter
  43. case, the size of the file was almost doubled. GIFSTRIP also does some
  44. basic file analysis and enforces a few format requirements which are
  45. sometimes ignored. For temporary storage, it can use disk files and most
  46. types of memory. By default, it uses all available types of memory first
  47. and only uses disk space to make up the shortfall if there is not enough
  48. space available among all the different types of memory (see section
  49. 2.2.3 for a more detailed discussion). By default, GIFSTRIP also keeps
  50. the original file around until the new file has been written to disk
  51. successfully (see section 2.2.2 for a more detailed discussion).
  52.  
  53.  1.1 Quick Reference
  54.  -------------------
  55.  
  56.     This is a quick summary of the usage and options of GIFSTRIP.
  57. Invoking GIFSTRIP with the option "-?" will produce a similar summary.
  58. Complete explanations may be found in section 2.
  59.  
  60.    usage: gifstrip [options] target [target ...]
  61.       target       filename, filename with wildcards, or path. Wildcards
  62.                     are *, ?, and ranges or groups specified in []. A
  63.                     range or group may be complemented with ^ or !.
  64.  
  65.       -b           BATCH: suppresses all console output. Should be first
  66.                     on the line. Returns ERRORLEVEL 0 if OK or stripped
  67.                     OK, 1 if a non-GIF file was found, 2 if the GIF file
  68.                     ended unexpectedly, or 3 on error.
  69.       -r           Sends error messages to stderr instead of stdout.
  70.  
  71.       -f           Forces rebuild. Normally file is not rebuilt if no
  72.                     extra characters are found and file meets format
  73.                     requirements.
  74.       -n           Disables strict format requirements.
  75.       -m           Enables checking for leading junk characters (from a
  76.                     Mac, for example).
  77.       -o           Causes the original file to be erased before the new
  78.                     file is written to disk. This is useful if the disk
  79.                     is nearly full and there is not enough room for two
  80.                     copies of the file.
  81.  
  82.       -c           Do not use CONVENTIONAL memory for temporary storage.
  83.       -e           Do not use EMS memory for temporary storage.
  84.       -x           Do not use XMS memory for temporary storage.
  85.       -d           Do not use DISK for temporary storage.
  86.       -s           Use ONLY DISK for temporary storage. Equivalent to
  87.                     the combination -c -e -x.
  88.       -tpath       Specify path for DISK temporary storage.
  89.  
  90.       -#           VERSION: Prints version information on internal
  91.                     modules, then exits.
  92.  
  93.    GIFSTRIP automatically reads a list of targets from stdin if stdin is
  94. redirected. Targets must be separated by newlines, and are
  95. wildcard-expanded in the same way as command-line targets. Note that
  96. command-line targets are ignored if stdin is redirected; if stdin is not
  97. redirected, there must be at least one target on the command line.
  98.  
  99.    Note that at least one of conventional, EMS, XMS, or disk storage
  100. must be allowed.
  101.  
  102.    Options are case-insensitive, and may not be combined.
  103.  
  104.  1.2 Copyright, License, and Warranty Disclaimer
  105.  -----------------------------------------------
  106.  
  107.    The Graphics Interchange Format(c) is the Copyright property of
  108. CompuServe Incorporated. GIF(sm) is a Service Mark property of
  109. CompuServe Incorporated.
  110.  
  111.    GIFSTRIP is not in the public domain. All the files are copyright
  112. 1993 by James W. Birdsall, all rights reserved.
  113.  
  114.    The following license applies to the entire Chiaro suite, which is
  115. made up of all the files listed in the file MANIFEST. Permission is
  116. granted to do the following:
  117.  
  118.         You may freely redistribute this archive, so long as it contains
  119.         all the files listed in the file MANIFEST, intact and
  120.         unmodified.
  121.  
  122.         You may use the programs contained in this archive for a period
  123.         of 30 days for evaluation purposes.
  124.  
  125.    Payment of the $10 shareware fee (which covers all the programs in
  126. the Chiaro suite) licenses you to use the Chiaro suite beyond the
  127. evaluation period. This license-to-use specifically includes use by
  128. bulletin board systems and other commercial or private information
  129. services.
  130.  
  131.    Registered users will also receive update notices and bug reports,
  132. and are entitled to use future versions without further payment.
  133.  
  134.    The contents of the distribution archive, and all other related
  135. files, information, and services are provided "as is" and without
  136. warranty. To the extent permitted by applicable law, the author
  137. disclaims all warranties, express or implied, including but not limited
  138. to, any implied warranty of merchantability or fitness for a particular
  139. purpose. While effort has been made to ensure that the files,
  140. information, and services are accurate and correct, the author shall not
  141. be liable for damages arising out of the use of or inability to use this
  142. product, including but not limited to, loss of profit, data, or use of
  143. this software, or special, incidental, or consequential damages or other
  144. similar claims, even if the author has been specifically advised of the
  145. possibility of such damages. Some states do not allow the exclusion of
  146. incidental or consequential damages, so the foregoing limitation may not
  147. apply to you.
  148.  
  149.    Information on contacting the author is provided at the end of this
  150. file.
  151.  
  152.  
  153. 2. USAGE
  154. --------
  155.  
  156.    GIFSTRIP may be called with zero or more options interspersed with
  157. zero or more targets. All options are scanned before any file searching
  158. is done, so order of options and targets is unimportant. If the standard
  159. input is not redirected, at least one target must be specified on the
  160. command line. If the standard input is redirected (is not the keyboard),
  161. GIFSTRIP will detect this and will attempt to read a list of targets,
  162. separated with newlines, from the standard input. Targets on the command
  163. line will be ignored, but options on the command line will be used. This
  164. feature is for use with the "front end" option of CHILS.
  165.  
  166.    GIFSTRIP requires 110,000 bytes of free conventional memory to run.
  167. Additional free conventional memory (and/or free EMS and/or XMS memory)
  168. improves performance.
  169.  
  170.  2.1 Targets
  171.  -----------
  172.  
  173.    A target can consist of a filename (optionally with path), a path, or
  174. a filename with wildcards (again, optionally with path). In the case of
  175. a filename, that file is checked. In the case of a path, all files in
  176. the specified directory are checked. In the case of a filename with
  177. wildcards, all files in the appropriate directory (the current directory
  178. if no path is given) matching the wildcards are checked.
  179.  
  180.    If a file that is checked is a GIF format file, it is processed. If
  181. it is not, it is not processed.
  182.  
  183.   2.1.1 Wildcards
  184.   ---------------
  185.  
  186.    Wildcards are much closer to the UNIX standard than the MS-DOS
  187. standard. The characters * and ? retain their ordinary meanings but
  188. matching